Model Attribute Description

The HL7 attribute classCode describes this class as an assigned role. An assigned role is a type of agent in which, the player is a person employed by a scoping organisation.

Implementation in XML Instance

The XML attribute classCode is fixed to "ASSIGNED".

Schema Constraint

• The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
  

Model Attribute Description

The HL7 attribute code uses a code from the RBAC list of codes.

Implementation in XML Instance

When using RBAC the code shall be populated using the value contained on the person's smart card.

The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

• The XML attribute code shall contain the code from RBAC
• The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.196"
• The XML attribute displayName shall carry the description associated with the person's RBAC code

Model Attribute Description

The HL7 attribute id uses one or more identifier(s) including local identifiers to identify the person who is the author.

Implementation in XML Instance

SDS identifiers shall be used as below:

The first instance of the XML element id is mandatory and shall carry the SDS User ID, the second instance of XML element id is required and shall carry the SDS User Role Profile ID when available on the sending system. The identifiers shall be carried in the XML element id as follows:

The first instance of the XML element id shall carry an SDS identifier that uniquely identifies the person as follows:

• The XML attribute root shall contain the OID "1.2.826.0.1285.0.2.0.65"
• The XML attribute extension shall contain the SDS User ID
  

The second instance of the XML element id shall carry the SDS identifier that uniquely identifies the role profile of the person as follows:

• The XML attribute root shall contain an OID with the value "1.2.826.0.1285.0.2.0.67"
• The XML attribute extension shall contain the SDS Role Profile ID

When the SDS User Role Profile ID cannot be sent because there is no information to populate the second instance of the XML element id available on the sending system, then the XML attribute NullFlavour of the XML element id should contain "NI".

A link to the author person.

A link to the represented organisation.

Model Attribute Description

The HL7 attribute classCode describes this class as a person.

Implementation in XML Instance

The XML attribute classCode is fixed to "PSN".

Schema Constraint

• The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

Model Attribute Description

The HL7 attribute determinerCode describes this class as an instance of a person.

Implementation in XML Instance

The XML attribute determinerCode is fixed to "INSTANCE".

Schema Constraint

• The attribute determinerCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

Model Attribute Description

The HL7 attribute name provides a name associated with the author of the query.

Implementation in XML Instance

The Person Name Structured with optional Use and optional Valid Time flavour of the PN data type is the recommended format for the name of the author. This information is carried in the XML element name as follows:

• The XML element prefix should contain the author's title
• The XML element given should contain the author's forenames; there can be as many occurrences of the XML element as required
  
• The XML element family should contain the author's surname
• The XML element suffix may contain any suffix for the author

Additionally the XML attribute use of the XML element name should be used to indicate the type of name; the recommended codes to be used are listed below:

Note some of the codes listed are NHS extensions, these are marked with an *

Code	Definition
L	Legal
PREFERRED *	Preferred name

Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:

• The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
• The XML attribute extension is fixed to "COCT_TP145102GB01#assignedAuthorPerson"

Schema Constraint

• The attribute root is prohibited in the schema and therefore does not appear in the "on the wire" instance.
• The attribute extension is prohibited in the schema and therefore does not appear in the "on the wire" instance.

Model Attribute Description

The HL7 attribute classCode describes this class as an organisation.

Implementation in XML Instance

The XML attribute classCode is fixed to "ORG".

Schema Constraint

• The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

Model Attribute Description

The HL7 attribute determinerCode describes this class as an instance of an organisation.

Implementation in XML Instance

The XML attribute determinerCode is fixed to "INSTANCE".

Schema Constraint

• The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
  

Model Attribute Description

The HL7 attribute id uses an ODS code as an identifier that uniquely identifies the organisation which employs the author. The ODS code should identify the organisation at either the site level or organisation level. Where possible the organisation should be identified at the site level. ODS codes were formerly known as NACS codes.

Implementation in XML Instance

When ODS site code is used then the XML element id is populated in the following way:

• The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.2"
• The XML attribute extension shall contain the ODS site code.

When ODS organisation code is used then the XML element id is populated in the following way:

• The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.1"
• The XML attribute extension shall contain the ODS organisation code.

Model Attribute Description

The HL7 attribute name uses the description of the organisation associated with the ODS code.

Implementation in XML Instance